Skip to main content
Feedback

Environment Settings

Overview

In the environment settings, you can make basic configurations, such as changing the name or the color of the environment. You can also use the Actions menu at the top right of the page to access more advanced options. You can delete the entire environment, call the environment wizard again, or renew your environment token.

Administration Portal - Environment - Settings

Settings of the Environment

All relevant setting options are listed and described in the table below.

SettingsDescription
Technical NameThe technical name of an API must be unique.
Display NameThe display name can differ from the technical name and does not have to be unique.
URLThe base URL at which the APIs from this environment are made available. It is used to generate the full API URL that is displayed to users after subscribing to an API. Environment Settings > Environment URLs
Platform TypeThe platform type of the environment cannot be changed.
AgentThe status of the agent. Platforms, Environments and Stages
StatusIf the environment is inactive, the agent will not be able to connect.
ProductionThe Stage of the environment.
Color, SymbolThis allows you to distinguish your environments more easily.
API URL StrategyThis setting is related to the URL Pattern Override from the API settings. The results are only available in the corresponding Developer Portal. Platform Default uses the default strategy for the specified platform. For AWS, the API URL pattern as a subdomain is used. For all other platforms, the pattern is appended to the path of the environment URL. For example, https://my-environment-url/my-api-url or https://my-api-url.my-environment-urlPath. Path appends the API URL pattern to the environment URL as part of the path. For example, https://my-api-url.my-environment-url. Sub Domain adds the API URL pattern as a subdomain at the beginning of the host of the environment URL. For example, https://my-environment-url/my-api-url

Environment URLs

The following describes what URL to configure for your environment and how it is used to build the specific API URLs that your users will see after subscribing to an API in that environment.

  • Boomi API Gateway: The public URL. If a public URL is not specified, it is the bind address.

  • Kong: The URL of your Kong proxy (e.g. http://my-kong:8000). API URLs are built by appending the path of the first route of a service (e.g. http://my-kong:8000/petstore).

  • WSO2: The URL of your WSO2 gateway (e.g. http://my-wso2:8280). API URLs are built by appending the context and version of the API (e.g. http://my-wso2:8280/petstore/1.0.6)

  • Gravitee: The URL of the Gravitee gateway (e.g. http://my-gravitee:8082). API URLs are built by appending the API context path to the environment URL (e.g. http://my-gravitee:8082/petstore).

  • AWS: The URL depends on the region where your AWS API gateway is hosted and the stage you want to use with this environment: https://execute-api.<region>.amazonaws.com/<stage> (e.g. https://execute-api.eu-central-1.amazonaws.com/development). API URLs are built by prepending the API id (e.g. https://22abcgc8u3.execute-api.eu-central-1.amazonaws.com/test).

  • Azure: The URL is the gateway URL that can be found in Azure on the overview page of your API management service (e.g. https://my-api-management-service.azure-api.net). API URLs are built by appending the API URL suffix of that API (e.g. https://apiim-hello-world-resource.azure-api.net/petstore).

  • Apigee: API URLs are built by appending the path from the first proxy endpoint of an API Proxy.

  • Layer7: The URL of your Layer7 gateway (e.g. https://my-gateway:8443) Not the URL of the Layer7 developer portal! API URLs are built by appending the custom resolution path configured for the corresponding service in the gateway (e.g. https://my-gateway:8443/petstore).

  • Layer7 + Boomi: The URL of your Layer7 gateway (e.g. https://my-gateway:8443) Not the URL of your AAGM instance. API URLs are built by appending the custom resolution path configured for the corresponding service in the gateway (e.g. https://my-gateway:8443/petstore).

On this Page